Aminet 1 (Walnut Creek)/Aminet - June 1993 [Walnut Creek].iso/aminet/text/misc/texinfo216.lzh/README

Text File | 1992-10-09 | 8KB | 196 lines

Texinfo, Version 2.16
=====================

9 October 1992
Robert J. Chassell

"Texinfo" is a documentation system that uses a single source file to
produce both on-line information and printed output.  This means that
instead of writing two different documents, one for the on-line help
or other on-line information and the other for a typeset manual or
other printed work, you need write only one document.  When the work
is revised, you need revise only one document.  You can read the
on-line information, known as an "Info file", with an Info
documentation-reading program.  Texinfo is described in the Texinfo
Manual.

* This is a very late beta test.

  You can now use the `@set' command to specify a value for a flag,
  which is expanded by the `@value' command.  The value is a string a
  characters.  (You can continue to use `@set' to set a flag.)

  The new `C-c C-c C-d' (texinfo-start-menu-description) command in
  GNU Emacs Texinfo mode inserts a node's section or chapter title in
  the space for the description in a menu entry line.  You must edit
  the inserted text since a title tends to use the same words as a
  node name but a useful description uses different words.  The menu
  updating commands no longer insert titles by default.

  The obnoxious contents-on-last-page-of-index bug in texinfo.tex is
  fixed.

  This release includes:

        texinfo2.texi edition 2.16
        texinfo.tex   version 2.86
        texinfmt.el   version 2.26
        texinfo.el    version 2.12
        texnfo-upd.el version 2.15
        texnfo-tex.el version 2.07      same as in release 2.15
        makeinfo.el   version 2.04      same as in release 2.15
        texi2dvi      version 0.2       same as in release 2.15
        makeinfo.c    version 1.49
        info.c        version 1.45
        texindex.c    version 1.45      same as in release 2.15

* Note that the info.el included in this distribution is the same
  info.el distributed with Emacs version 18.

* Note for people running TeX: the new `@cartouche' command requires a
  a font, `lcircle10' that is occasionally called `circle10' in older
  TeX distributions.

  To avoid trouble, use `make install' to install this package.
  This will install `lcircle10' as an alias for `circle10'
  if you don't have it already.  You can also run the script
  `fixfonts' to install the alias and do nothing else.

  Detailed information about this problem can be found at the end
  of this file.

* Please try this out and send me bug reports.

Thanks

Bugs to [e-mail].  I maintain the Emacs Lisp files and the
manual.  I forward bug reports for info, makeinfo, and texindex to
[e-mail], reports for texinfo.tex to [e-mail],
and reports for texi2dvi to [e-mail].

Use a command such as 'tar xvzf texinfo2.tar.Z' to uncompress and
extract the files.

This directory contains version 2 of the Texinfo package:

    texinfo2.texi           This is Edition 2 of the Texinfo Manual

    README                  This file
    Makefile                Create a compressed tar file of the package,
                                as distributed
    New-features            Summary of new features
    texinfo.tex             Definitions file used by Tex
    texi2dvi                Shell script for producing indexed DVI files

    >texi2roff< to be added when new version is ready
                            Convert Texinfo file to [nt]roff form.

The `elisp' subdirectory contains Emacs lisp code:

    texinfo.el        Texinfo mode
    texnfo-upd.el     Texinfo node and menu updating
    texinfmt.el       Emacs Lisp Info formatting
    makeinfo.el       Emacs interface to the `makeinfo' formatting program
    texnfo-tex.el     TeX and hardcopy printing
    info.el           The standard Emacs version 18 Info files,
    informat.el           included here for convenience.

All these files should be installed in the default load-path for Emacs;
otherwise Emacs will not be able to load the autoloaded support files,
such as `texinfmt.el'.  The `texinfo.el' file contains the autoload
commands; it is the only file that needs to be loaded initially.

The `C' subdirectory contains C code:

    makeinfo.c        `makeinfo' source
    info.c            `info' source
    getopt.c          support files
    getopt1.c
    getopt.h

    texindex.c        sort indices for TeX; included here for convenience

    configure         Create a Makefile which in turn creates an `info' or
                      `makeinfo' executable, or a C sources
                      distribution.

    configure.in      Template for creating `configure' using m4 macros
              (distributed separately under the name `autoconf').

    Makefile.in       Template for `configure' to use to make a Makefile

                      (Run `configure' first, then `make' to compile
                      info, makeinfo, and texindex.)

This separate Texinfo package is temporary; after a period of testing,
this documentation and software will be merged into the Emacs
distribution.  (But we may continue to distribute this in a
separate package as well, for the convenience of those who just want
these files.)


Special note for TeX: Finding the right font for @cartouche
===========================================================

The `@cartouche' command requires a a font, `lcircle10' that is
occasionally called `circle10' in older TeX distributions.  If you see
the following error message

     ! Font \circle=lcircle10 not loadable: Metric (TFM) file not found.

your system may be using the older font.

If it is, you can use `circle10' in place of `lcircle10'.  Since the
emerging convention is to use the new name, we recommend you keep
`texinfo.tex' as is and make symbolic links to the font files with the
old names.

You will need to make symbolic links to several font files.  Look for
files with names similar to the following:

`circle10.mf'
     This is the Metafont source for the font; sometimes used
     automatically by DVI output programs to generate pixel files.

`circle10.tfm'
     This is the file actually used by TeX; it describes the
     measurements of the characters in the font.

`circle10.300pk'
`circle10.96pk'
     `pk' files contain the pixels for the character images that are
     used by your DVI output program.  On your system, these files may
     have other numbers where this example shows "300" and "96".  You
     may also have more, or fewer, `pk' files.

`circle10.300gf'
`circle10.96gf'
     `gf' files are an older alternative to `pk' files; if you can't
     find the `pk' files, look for these.  As with the `pk' files, the
     numbers may be different on your system.

Establish links to each of these files so they're available with both
the `circle10' and the `lcircle10' prefix.  If you can't do this, or
don't know how to, contact the person responsible for TeX at your
site.  If possible, use symbolic links (`ln -s') so you can more
easily keep track of what you have done.

For example, you could make a line in the directory where you found
`circle10.tfm' on your system as follows:

     ln -s circle10.tfm lcircle10.tfm

You may have more, or fewer, `pk' (or `gf') files than in our example.
Don't worry about this; just link each of the `circle10' `pk' (or
`gf') files you have to the corresponding `f'lcircle10 file.  Usually
all the `pk' files for one font are in a single directory, though it's
not always the same as the directory for `mf' or `tfm' files.

When fonts are all in one directory, you can make the links for all
the pixel files using a shell command such as the following, which is
for the GNU shell:

     for pk in circle10.*pk; do ln -s $pk l$pk; done

================ end README file